Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: playbook parameter docs #291

Merged
merged 7 commits into from
Oct 8, 2024
Merged

fix: playbook parameter docs #291

merged 7 commits into from
Oct 8, 2024

Conversation

adityathebe
Copy link
Member

@adityathebe adityathebe commented Oct 1, 2024

resolves: #224

not sure exactly what #224 was pointing to but I have made some improvements.

Copy link

netlify bot commented Oct 1, 2024

Deploy Preview for flanksource-docs ready!

Name Link
🔨 Latest commit 820248d
🔍 Latest deploy log https://app.netlify.com/sites/flanksource-docs/deploys/6703a88376b6620008ba4206
😎 Deploy Preview https://deploy-preview-291--flanksource-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Oct 1, 2024

Deploy Preview for canarychecker canceled.

Name Link
🔨 Latest commit 820248d
🔍 Latest deploy log https://app.netlify.com/sites/canarychecker/deploys/6703a88321273900080e5bca

@moshloop
Copy link
Member

moshloop commented Oct 1, 2024

Can we add snippet examples for each of the param types?

And maybe use a kitchen sink example with all options:

flanksource/mission-control@96c658f

@moshloop
Copy link
Member

moshloop commented Oct 2, 2024

@adityathebe - Can you also check any vale lint errors ? We probably need to force value to exit on error, and only run it on changed files with something like: https://github.com/marketplace/actions/changed-files

@adityathebe adityathebe force-pushed the fix/playbook-parameter-docs branch 7 times, most recently from a10faf3 to 968627b Compare October 2, 2024 14:25
@adityathebe
Copy link
Member Author

@moshloop added vale checks on changed files.

Added few more words on the ignore list and sorted it.

@moshloop moshloop merged commit 7e3c014 into main Oct 8, 2024
9 checks passed
@moshloop moshloop deleted the fix/playbook-parameter-docs branch October 8, 2024 13:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Playbook parameters docs are wrong
2 participants